Update the documentation url path to read from metadata #4829
Conversation
|
Hi, as long as the metadata is not provided in the linting, we cannot really merge this. Or am I wrong? |
@barmac That's correct. I have made the changes to linting and bpmn-io-bpmnlint repos. I will share the dependent PRs shortly. Thanks. |
|
I'm converting this to draft then. |
|
@barmac The changes are ready for your review. Here's the changes related to implementation: |
|
Thanks, we will merge it together with the bpmnlint update. |
| @@ -91,7 +91,7 @@ function LintingTabItem(props) { | |||
|
|
|||
| const { | |||
| category, | |||
| documentation = {}, | |||
| meta = {}, | |||
There was a problem hiding this comment.
| meta = {}, | |
| meta, |
Given the later line:
const documentationUrl = meta?.documentation?.url;
We get away with meta not existing.
| @@ -55,8 +55,10 @@ describe('<LintingTab>', function() { | |||
| name: 'Foo', | |||
| message: 'Foo message', | |||
| rule: 'foo-rule', | |||
| documentation: { | |||
| url: 'https://foo.bar' | |||
| meta: { | |||
There was a problem hiding this comment.
I believe this requires adjustment in @camunda/linting to ensure that custom URLs are appropriately injected:
There was a problem hiding this comment.
Thinking about it, camunda/linting#129 should be the way to go. We can simply inject documentation in the original compat rules and this PR is fine without additional upstream adjustments. 👏
nikku
added
in progress
bpmn-io-tasks
Git issue: #4491
Related PRs:
Linting: Moved the logic to bpmnlint -- camunda/linting#129
bpmnlint: bpmn-io/bpmnlint#159